.. _Actor:

==========================
Actor
==========================

.. toctree::
   :maxdepth: 2
   :hidden:
   :glob:
   
   EEex*


+-----------------------------------------------------------------------+----------------------------------------------------+
| **Function**                                                          | **Description**                                    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_AlterActorEffect<EEex_AlterActorEffect>`                   | Alters effects like WeiDU ALTER_EFFECT but ingame  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_ApplyEffectToActor<EEex_ApplyEffectToActor>`               | Directly applies an effect to actor from args table|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorAlignment<EEex_GetActorAlignment>`                 | Return alignment of actor                          |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorAllegiance<EEex_GetActorAllegiance>`               | Returns the actor's allegiance                     |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorAnimation<EEex_GetActorAnimation>`                 | Returns the actor's animation                      |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorAreaRes<EEex_GetActorAreaRes>`                     | Returns the actor's current area resref as a string|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorAreaSize<EEex_GetActorAreaSize>`                   | Gets the max X and Y coords of area the actor is in|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorBaseCharisma<EEex_GetActorBaseCharisma>`           | Returns the actor's base charisma                  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorBaseConstitution<EEex_GetActorBaseConstitution>`   | Returns the actor's base constitution              |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorBaseDexterity<EEex_GetActorBaseDexterity>`         | Returns the actor's base dexterity                 |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorBaseIntelligence<EEex_GetActorBaseIntelligence>`   | Returns the actor's base intelligence              |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorBaseStrength<EEex_GetActorBaseStrength>`           | Returns the actor's base strength                  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorBaseWisdom<EEex_GetActorBaseWisdom>`               | Returns the actor's base wisdom                    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorCastTimer<EEex_GetActorCastTimer>`                 | Returns cast counter value for the specified actor |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorClass<EEex_GetActorClass>`                         | Returns the actor's class                          |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorClassScript<EEex_GetActorClassScript>`             | Returns the actor's class script                   |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorClassString<EEex_GetActorClassString>`             | Returns actor class as a string                    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorCurrentDest<EEex_GetActorCurrentDest>`             | Returns actor current destination                  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorCurrentHP<EEex_GetActorCurrentHP>`                 | Returns the actor's current HP                     |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorDefaultScript<EEex_GetActorDefaultScript>`         | Returns actor's default script resref as a string  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorDialogue<EEex_GetActorDialogue>`                   | Returns the actor's dialogue resref as a string    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorDirection<EEex_GetActorDirection>`                 | Returns the actor's direction                      |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorEffectResrefs<EEex_GetActorEffectResrefs>`         | Returns a list of effects as resource references   |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorGender<EEex_GetActorGender>`                       | Returns the actor's gender                         |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorGeneral<EEex_GetActorGeneral>`                     | Returns the actor's general                        |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorGeneralScript<EEex_GetActorGeneralScript>`         | Returns actor's general script resref as a string  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorKit<EEex_GetActorKit>`                             | Returns the kit for the actor                      |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorLocal<EEex_GetActorLocal>`                         | Gets a LOCALS variable in the actor's .CRE         |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorLocation<EEex_GetActorLocation>`                   | Returns a point coordinate indicating location     |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorModalState<EEex_GetActorModalState>`               | Returns the actor's current modal state (MODAL.IDS)|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorModalTimer<EEex_GetActorModalTimer>`               | Returns the modal timer value for the actor        |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorMovementRate<EEex_GetActorMovementRate>`           | Returns the actor's movement rate                  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorName<EEex_GetActorName>`                           | Returns actor's name as a string                   |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorOverrideScript<EEex_GetActorOverrideScript>`       | Returns actor's override script resref as a string |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorPosDest<EEex_GetActorPosDest>`                     | Return the destination position of the actor       |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorRace<EEex_GetActorRace>`                           | Returns the actor's race                           |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorRaceScript<EEex_GetActorRaceScript>`               | Returns the actor's race script resref as a string |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorRequiredDirection<EEex_GetActorRequiredDirection>` | Returns the direction for the actor to face a point|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorScriptName<EEex_GetActorScriptName>`               | Returns the script name for the actor              |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorShare<EEex_GetActorShare>`                         | Returns internal actor information                 |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorSpecific<EEex_GetActorSpecific>`                   |                                                    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorSpecificsScript<EEex_GetActorSpecificsScript>`     | Returns actor's specifics script resref as a string|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorSpellRES<EEex_GetActorSpellRES>`                   | Returns the resref of spell the actor is casting   |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorSpellState<EEex_GetActorSpellState>`               | Returns spell state for the actor                  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorSpellTimer<EEex_GetActorSpellTimer>`               |                                                    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorStat<EEex_GetActorStat>`                           |                                                    |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorTargetID<EEex_GetActorTargetID>`                   | Returns the ID of the target of the actor's action |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetActorTargetPoint<EEex_GetActorTargetPoint>`             | Return the target of the actor as a point          |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetImageMasterID<EEex_GetImageMasterID>`                   | Returns the actor ID of the image's master         |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_GetSummonerID<EEex_GetSummonerID>`                         | Returns summoner actor ID of a summoned creature   |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_HasState<EEex_HasState>`                                   | Returns true if the actor has the specified state  |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsActorFacing<EEex_IsActorFacing>`                         | Returns true if actor is facing target             |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsActorInCombat<EEex_IsActorInCombat>`                     | Returns true if the given actor is in combat       |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsImmuneToOpcode<EEex_IsImmuneToOpcode>`                   | Returns true if actor is immune to specified opcode|
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsImmuneToSpellLevel<EEex_IsImmuneToSpellLevel>`           | Returns true if actor is immune to spell level     |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IsSprite<EEex_IsSprite>`                                   | Returns true if the actor is a creature            |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_IterateActorEffects<EEex_IterateActorEffects>`             | Iterate actor effects                              |
+-----------------------------------------------------------------------+----------------------------------------------------+
| :ref:`EEex_SetActorLocal<EEex_SetActorLocal>`                         | Sets a LOCALS variable in the actor's .CRE         |
+-----------------------------------------------------------------------+----------------------------------------------------+